home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / misc / resourcedemo.lha / ReSourceDemo / ReadMe < prev    next >
Encoding:
Text File  |  1993-04-09  |  12.2 KB  |  281 lines
  1. COPYRIGHT
  2. ReSource,  demo   version   "RSDemo",   associated   utility   software,  and
  3. documentation  are  copyrighted ©1993 by The Puzzle Factory, Inc.  All rights
  4. Reserved.
  5.  
  6. This demonstration version of ReSource  is  freely  redistributable  provided
  7. that it is distributed in its entirety along with all supplied libraries, and
  8. that no changes are made in either the program or documentation.
  9.  
  10. TRADEMARKS
  11. ReSource and RSDemo are Trademarks of The Puzzle Factory, Inc.
  12.  
  13. Macro68 is a trademark of DigiSoft Pty. Ltd.
  14.  
  15. Amiga, AmigaDOS, Kickstart, Intuition, and Workbench are trademarks of
  16. Commodore-Amiga, Inc.
  17.  
  18. DISCLAIMER
  19. The Puzzle Factory, Inc. provides this program "as-is"  without  warranty  of
  20. any  kind,  either  expressed  or implied, including, but not limited to, the
  21. implied warranties of merchantability and fitness for a  particular  purpose.
  22. The  entire  risk as to the results and performance of the program is assumed
  23. by you.  Should the program prove defective, you (and not The Puzzle Factory,
  24. Inc.)   assume  the  entire  cost  of  all  necessary  servicing,  repair  or
  25. correction.  Further, The Puzzle Factory, Inc. does not warrant, guarantee or
  26. make  any  representation regarding the use of, or the results of the use of,
  27. the program in terms of correctness, accuracy, reliability,  currentness,  or
  28. otherwise; and you rely on the program and results solely at your own risk.
  29.  
  30. If you like ReSource and wish to order the commercial version,
  31. please contact:
  32.  
  33.     The Puzzle Factory, Inc.          Voice: 503:935-3709
  34.     P.O. Box 986                Support BBS: 503:935-7883
  35.     Veneta, OR 97487                    BIX: jblavin
  36.     USA                            Internet: jlavin@cie.uoregon.edu
  37.  
  38. In Europe contact:
  39.  
  40.     Helios Software                   Voice: (0623) 554828
  41.     163 Huthwait Road
  42.     Sutton-in-Ashfield
  43.     Notts.  NG17 2HB
  44.     U.K.
  45.  
  46. *****************************************************************************
  47.  
  48. INTRODUCTION TO RESOURCE
  49. ========================
  50. ReSource is an interactive disassembler for Amiga computers.  There are other
  51. Amiga disassemblers, both public domain and commercial.  The following points
  52. characterize ReSource as distinct from other disassemblers:
  53.  
  54.     1. ReSource is fully interactive.
  55.     2. ReSource was written for the serious user.
  56.     3. ReSource understands the Amiga®.
  57.  
  58. Because ReSource can get its input from a file, track, or memory, and  output
  59. all or in part to any of these, it is more a general purpose tool than just a
  60. disassembler.  It can be used to browse through files, without ever bothering
  61. to save anything, just to find out what is inside.  It also knows quite a bit
  62. about AmigaDOS(tm) and the Amiga® OS.  This built-in intelligence  will  save
  63. you  a  great  deal  of  time  when  disassembling  files.   ReSource is also
  64. blindingly fast.  It is written entirely in assembly language, and  does  all
  65. text rendering using its own special internal routines.   The  following  are
  66. some of ReSource's features:
  67.  
  68.     ReSource is easy to work with.  ReSource will amaze you with its
  69.     ease of use and straightforward user  interface.   Unlike  other
  70.     disassemblers,  ReSource is fully interactive, and allows you to
  71.     "do it your way".  There are plenty of  options,  and  decisions
  72.     are not forced on you.
  73.  
  74.     ReSource is fast and thorough.  ReSource was designed to be used
  75.     by serious software developers.  ReSource is aimed at those that
  76.     need to disassemble large programs into source files  that  will
  77.     reassemble  and  run  correctly.   For a disassembler to achieve
  78.     this, it must  be  able  to  produce  totally  bug-free  output.
  79.     Furthermore, it must be able to produce high-quality output with
  80.     the  minimum of effort from the user.  ReSource achieves both of
  81.     these objectives, albeit at the cost of large memory usage.
  82.  
  83.     ReSource makes the most of  your  programming  skills.   Because
  84.     ReSource  understands  AmigaDOS(tm)  and  the Amiga® OS, you can
  85.     concentrate on the task at hand, and not expend effort on trying
  86.     to look up or remember details better left to a computer.
  87.  
  88.  
  89. GETTING STARTED
  90. ===============
  91. This section is designed to get you started with ReSource.  It will guide you
  92. through installing ReSource on either a floppy based Amiga®, or a system with
  93. a hard drive.  It will explain some of the basics of operating ReSource.
  94.  
  95. System Requirements
  96. ReSource is designed to work on any  properly  configured  Amiga®  500,  600,
  97. 1000, 1200, 2000, 2500, 3000, or 4000.
  98.  
  99. Version 1.3 or higher of the Amiga® OS is required.
  100.  
  101. One megabyte of RAM is required, and you will need 1 1/2 to  2  megabytes  of
  102. RAM if you want to work with files larger than 30-40K.
  103.  
  104. Because ReSource uses functions in the "ARP" library, you must have the  file
  105. "arp.library"  in your "LIBS:" directory when you run ReSource.  This file is
  106. available from most BBS's.  The version of "arp.library" must be 34 or higher.
  107.  
  108. If you will be using ReSource under V1.3 of the Amiga® OS,  we  suggest  that
  109. you  run  FastFonts©  or  Blitzfonts©.  Otherwise, scanning through the menus
  110. will be very sluggish due to the large number of sub-items.
  111.  
  112. Archive Contents
  113. ================
  114. The Official ReSource Demo archive contains the following files:
  115.  
  116.   ReadMe                       This file
  117.   ReadMe.info                  Icon to view ReadMe
  118.   Start_Resource               Script to do temporary installation and run
  119.   Start_ReSource.info          Icon to run the script
  120.   RSDemo                       The main disassembler, demo version
  121.   RSDemo.info                  Icon to run RSDemo
  122.   libs/ReSourceloader.library  Library required for ReSource
  123.   libs/ReSourcemenus.library   Required for access to menus
  124.   libs/ReSourcesyms.library    Required for access to internal symbol bases
  125.   libs/ReSourcehelp.library    Required for online help facility
  126.   s/RS.keytable                Default keytable
  127.   s/RS.macros                  Example macros
  128.  
  129. Installation
  130. ============
  131. Unpack the archive using the utility of your choice.  Be careful to  preserve
  132. path  information  when  doing so.  You should end up with a list of files as
  133. shown above.   To  do  an  easy  trial  installation,  double  click  on  the
  134. "Start_ReSource" icon.
  135.  
  136. For a permanent installation, just copy the above files as shown below:
  137.  
  138.   copy RSDemo                       <anywhere in your path, e.g. 'C:'>
  139.   copy RSDemo.info                  <as above>
  140.   copy libs/ReSourceloader.library  libs:   ;or libs:ReSource/
  141.   copy libs/ReSourcemenus.library   libs:   ;or libs:ReSource/
  142.   copy libs/ReSourcesyms.library    libs:   ;or libs:ReSource/
  143.   copy libs/ReSourcehelp.library    libs:   ;or libs:ReSource/
  144.   copy s/RS.keytable                s:
  145.   copy s/RS.macros                  s:
  146.  
  147. No assignments need to be made.  Installation is now complete.
  148.  
  149. Starting ReSource
  150. =================
  151. If you will be starting ReSource from the CLI, at the prompt type:
  152.  
  153.    1> run RSDemo       ;the word "run" is optional.
  154.  
  155.    1> RSDemo <ProgName>
  156.    The executable program <ProgName> will be loaded as a load file if it is a
  157.    load file.  Otherwise, it will be loaded as a ".RS" data file  if  it's  a
  158.    data file.  Otherwise, it will be loaded as a binary file.  Corrupted load
  159.    files may have to be loaded as a binary image.
  160.  
  161.    1> RSDemo *b <FileName>
  162.    The file <FileName> will be loaded as a binary image.
  163.  
  164.    1> RSDemo *m <Sloc> <Eloc>
  165.    Load memory, from location <Sloc> to location <Eloc>.
  166.  
  167.    1> RSDemo *DFn: <Scyl> <Ecyl+1>  [#sec]  [Offsec]  Load  from  drive  DFn:
  168.    starting at cylinder <Scyl> and continuing to <Ecyl+1>.  The default is to
  169.    read  complete  track(s).   This  may be modified by the next two optional
  170.    parameters:  The fourth parameter  specifies  that  ReSource  should  read
  171.    [#sec]  extra  sectors, and the fifth parameter specifies that rather than
  172.    begin reading from the  start  of  <Scyl>,  offset  the  start  sector  by
  173.    [Offsec] sectors.
  174.  
  175.    Using "?" as the first parameter on the  command  line  will  display  the
  176.    parameter syntax requirements, then exit immediately.
  177.  
  178.    ReSource will accept "-I" or "-i" as the first parameter  on  the  command
  179.    line.  This will force ReSource to use an interlaced screen.  Note that if
  180.    your  Workbench(tm)  screen is in interlace mode, this flag has no effect.
  181.  
  182.    Conversely, to force ReSource to use a non-interlaced screen, use "-N"  or
  183.    "-n" as the first parameter on the command line.  This will force ReSource
  184.    to use a non-interlaced screen.  Note that if your Workbench(tm) screen is
  185.    not in interlace mode, this flag has no effect.
  186.  
  187. If you will be starting ReSource from the Workbench(tm), double click on  the
  188. "RSDemo"  program  icon  or  "Start_ReSource"  script  icon.  Then use one of
  189. ReSource's functions to load a file, memory, or disk blocks.
  190.  
  191. Input and Output
  192. ================
  193. ReSource is quite flexible in the way that it allows you  to  load  and  save
  194. files and data.  For example, you may:
  195.  
  196.    1. Load as an Amiga® executable program
  197.    2. Load as an Amiga® file
  198.    3. Specify an area of memory to disassemble
  199.    4. Load 1 or more sectors/cylinders from a floppy disk
  200.    5. Load a previously saved ".RS" file
  201.  
  202. Regardless of how ReSource gets its input, it can save the  contents  of  its
  203. buffer in any of the following ways:
  204.  
  205.    1. Save as an Amiga® executable program
  206.    2. Save as a binary image
  207.    3. Save directly to memory
  208.    4. Save to floppy disk sectors/cylinders
  209.    5. Save as an ".RS" file
  210.    6. Save as an ".asm" file
  211.  
  212. NOTE: RSDemo, the demonstration version of ReSource will not  save  anything.
  213. This information is provided for those considering the commercial version.
  214.  
  215.  
  216. ONLINE HELP
  217. ===========
  218. ReSource contains a complete online help facility.  This silent assistant  is
  219. fast and easy to use.
  220.  
  221. The online help facility contains documentation on each  and  every  function
  222. that  can  be selected from the menus.  There is also a glossary of terms and
  223. phrases.   To  begin online help, press the "Help" key, or select "Help" from
  224. the PROJECT menu.
  225.  
  226. Hyper-help
  227. ==========
  228. While you are viewing the documentation on any particular function,  you  may
  229. notice  that  various words and phrases are lightly underlined.  By using the
  230. left and right arrow keys, you can hilite one of these words or phrases,  and
  231. by  then  pressing  the  return  key,  ReSource  will immediately display the
  232. documentation that pertains to that word or phrase.  While  in  this  "nested
  233. help" mode, you have only to press the backspace key, to go back to where you
  234. were.   For example, while viewing the documentation on the "CURSOR/Relative/
  235. Next line", you may be wondering what the word "cursor" means.   By  pressing
  236. the  right  arrow  key  until the word "cursor" is hilited, and then pressing
  237. return, you will be shown the  part  of  the  glossary  that  describes  what
  238. "cursor"  means  in ReSource.  Now satisfied, you may press the backspace key
  239. to continue reading the documentation on "CURSOR/Relative/Next line".
  240.  
  241. You  can  get  nested  help within nested help.  There is a limit to just how
  242. many positions within the help files ReSource will remember (256 levels), but
  243. it is highly unlikely that anyone will ever approach this limit.  In fact, it
  244. is unlikely that you will nest to a  depth  of  more  than  three  in  normal
  245. operation.
  246.  
  247. Help on Help
  248. ============
  249. While inside the help facility, there are a number of keys that can  be  used
  250. for  specific  purposes.   The most important one to remember is the help key
  251. itself, which tells you what the various keys do.  Here are a few of the more
  252. important ones:
  253.  
  254.     Help            Display this table
  255.     Escape            Exit from the online help facility
  256.     Down/Up arrows        Move forward/backward through text
  257.     Left/Right arrow    Use to hilite a word/phrase
  258.     Return            If word/phrase hilited, get help on it
  259.     Alt-down arrow        Move forward to end of text
  260.     Alt-up arrow        Move to start of text
  261.     Backspace        Return to previous level
  262.  
  263.  
  264. COMMERCIAL RESOURCE
  265. ===================
  266. ReSource comes with a manual containing much more information about  ReSource
  267. than  it  is possible to include here, as well as 2 step-by-step tutorials on
  268. disassembling programs using ReSource.
  269.  
  270. The OS 2.0 Include files and library offsets, as well as a  number  of  other
  271. tools and utilities are also included.
  272.  
  273. You will also get The Puzzle Factory's excellent customer support.
  274.  
  275. We  sincerely  hope  you  find ReSource to be an important part of your Amiga
  276. tool collection.  Please contact us if we can be of assistance.
  277.  
  278. The Puzzle Factory
  279.  
  280. =eof=
  281.